<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.dbcp2;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.lang.management.ManagementFactory;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.sql.Connection;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.sql.PreparedStatement;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.sql.ResultSet;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.sql.SQLException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Collection;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.Executor;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.management.InstanceAlreadyExistsException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import javax.management.MBeanRegistrationException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import javax.management.MBeanServer;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import javax.management.NotCompliantMBeanException;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import javax.management.ObjectName;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.commons.pool2.ObjectPool;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * A delegating connection that, rather than closing the underlying connection, returns itself to an {@link ObjectPool}<a name="line.36"></a>
<span class="sourceLineNo">037</span> * when closed.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @since 2.0<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>public class PoolableConnection extends DelegatingConnection&lt;Connection&gt; implements PoolableConnectionMXBean {<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span>    private static MBeanServer MBEAN_SERVER;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>    static {<a name="line.45"></a>
<span class="sourceLineNo">046</span>        try {<a name="line.46"></a>
<span class="sourceLineNo">047</span>            MBEAN_SERVER = ManagementFactory.getPlatformMBeanServer();<a name="line.47"></a>
<span class="sourceLineNo">048</span>        } catch (final NoClassDefFoundError | Exception ex) {<a name="line.48"></a>
<span class="sourceLineNo">049</span>            // ignore - JMX not available<a name="line.49"></a>
<span class="sourceLineNo">050</span>        }<a name="line.50"></a>
<span class="sourceLineNo">051</span>    }<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span>    /** The pool to which I should return. */<a name="line.53"></a>
<span class="sourceLineNo">054</span>    private final ObjectPool&lt;PoolableConnection&gt; pool;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    private final ObjectNameWrapper jmxObjectName;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>    // Use a prepared statement for validation, retaining the last used SQL to<a name="line.58"></a>
<span class="sourceLineNo">059</span>    // check if the validation query has changed.<a name="line.59"></a>
<span class="sourceLineNo">060</span>    private PreparedStatement validationPreparedStatement;<a name="line.60"></a>
<span class="sourceLineNo">061</span>    private String lastValidationSql;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span>    /**<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * Indicate that unrecoverable SQLException was thrown when using this connection. Such a connection should be<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * considered broken and not pass validation in the future.<a name="line.65"></a>
<span class="sourceLineNo">066</span>     */<a name="line.66"></a>
<span class="sourceLineNo">067</span>    private boolean fatalSqlExceptionThrown;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>    /**<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * SQL_STATE codes considered to signal fatal conditions. Overrides the defaults in<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * {@link Utils#DISCONNECTION_SQL_CODES} (plus anything starting with {@link Utils#DISCONNECTION_SQL_CODE_PREFIX}).<a name="line.71"></a>
<span class="sourceLineNo">072</span>     */<a name="line.72"></a>
<span class="sourceLineNo">073</span>    private final Collection&lt;String&gt; disconnectionSqlCodes;<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /** Whether or not to fast fail validation after fatal connection errors */<a name="line.75"></a>
<span class="sourceLineNo">076</span>    private final boolean fastFailValidation;<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span>    /**<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param conn<a name="line.80"></a>
<span class="sourceLineNo">081</span>     *            my underlying connection<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @param pool<a name="line.82"></a>
<span class="sourceLineNo">083</span>     *            the pool to which I should return when closed<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * @param jmxName<a name="line.84"></a>
<span class="sourceLineNo">085</span>     *            JMX name<a name="line.85"></a>
<span class="sourceLineNo">086</span>     */<a name="line.86"></a>
<span class="sourceLineNo">087</span>    public PoolableConnection(final Connection conn, final ObjectPool&lt;PoolableConnection&gt; pool,<a name="line.87"></a>
<span class="sourceLineNo">088</span>            final ObjectName jmxName) {<a name="line.88"></a>
<span class="sourceLineNo">089</span>        this(conn, pool, jmxName, null, true);<a name="line.89"></a>
<span class="sourceLineNo">090</span>    }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    /**<a name="line.92"></a>
<span class="sourceLineNo">093</span>     *<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * @param conn<a name="line.94"></a>
<span class="sourceLineNo">095</span>     *            my underlying connection<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * @param pool<a name="line.96"></a>
<span class="sourceLineNo">097</span>     *            the pool to which I should return when closed<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @param jmxObjectName<a name="line.98"></a>
<span class="sourceLineNo">099</span>     *            JMX name<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * @param disconnectSqlCodes<a name="line.100"></a>
<span class="sourceLineNo">101</span>     *            SQL_STATE codes considered fatal disconnection errors<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * @param fastFailValidation<a name="line.102"></a>
<span class="sourceLineNo">103</span>     *            true means fatal disconnection errors cause subsequent validations to fail immediately (no attempt to<a name="line.103"></a>
<span class="sourceLineNo">104</span>     *            run query or isValid)<a name="line.104"></a>
<span class="sourceLineNo">105</span>     */<a name="line.105"></a>
<span class="sourceLineNo">106</span>    public PoolableConnection(final Connection conn, final ObjectPool&lt;PoolableConnection&gt; pool,<a name="line.106"></a>
<span class="sourceLineNo">107</span>            final ObjectName jmxObjectName, final Collection&lt;String&gt; disconnectSqlCodes,<a name="line.107"></a>
<span class="sourceLineNo">108</span>            final boolean fastFailValidation) {<a name="line.108"></a>
<span class="sourceLineNo">109</span>        super(conn);<a name="line.109"></a>
<span class="sourceLineNo">110</span>        this.pool = pool;<a name="line.110"></a>
<span class="sourceLineNo">111</span>        this.jmxObjectName = ObjectNameWrapper.wrap(jmxObjectName);<a name="line.111"></a>
<span class="sourceLineNo">112</span>        this.disconnectionSqlCodes = disconnectSqlCodes;<a name="line.112"></a>
<span class="sourceLineNo">113</span>        this.fastFailValidation = fastFailValidation;<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span>        if (jmxObjectName != null) {<a name="line.115"></a>
<span class="sourceLineNo">116</span>            try {<a name="line.116"></a>
<span class="sourceLineNo">117</span>                MBEAN_SERVER.registerMBean(this, jmxObjectName);<a name="line.117"></a>
<span class="sourceLineNo">118</span>            } catch (InstanceAlreadyExistsException | MBeanRegistrationException | NotCompliantMBeanException e) {<a name="line.118"></a>
<span class="sourceLineNo">119</span>                // For now, simply skip registration<a name="line.119"></a>
<span class="sourceLineNo">120</span>            }<a name="line.120"></a>
<span class="sourceLineNo">121</span>        }<a name="line.121"></a>
<span class="sourceLineNo">122</span>    }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span>    /**<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * Abort my underlying {@link Connection}.<a name="line.125"></a>
<span class="sourceLineNo">126</span>     *<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * @since 2.9.0<a name="line.127"></a>
<span class="sourceLineNo">128</span>     */<a name="line.128"></a>
<span class="sourceLineNo">129</span>    @Override<a name="line.129"></a>
<span class="sourceLineNo">130</span>    public void abort(final Executor executor) throws SQLException {<a name="line.130"></a>
<span class="sourceLineNo">131</span>        if (jmxObjectName != null) {<a name="line.131"></a>
<span class="sourceLineNo">132</span>            jmxObjectName.unregisterMBean();<a name="line.132"></a>
<span class="sourceLineNo">133</span>        }<a name="line.133"></a>
<span class="sourceLineNo">134</span>        super.abort(executor);<a name="line.134"></a>
<span class="sourceLineNo">135</span>    }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>    /**<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * Returns me to my pool.<a name="line.138"></a>
<span class="sourceLineNo">139</span>     */<a name="line.139"></a>
<span class="sourceLineNo">140</span>    @Override<a name="line.140"></a>
<span class="sourceLineNo">141</span>    public synchronized void close() throws SQLException {<a name="line.141"></a>
<span class="sourceLineNo">142</span>        if (isClosedInternal()) {<a name="line.142"></a>
<span class="sourceLineNo">143</span>            // already closed<a name="line.143"></a>
<span class="sourceLineNo">144</span>            return;<a name="line.144"></a>
<span class="sourceLineNo">145</span>        }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span>        boolean isUnderlyingConnectionClosed;<a name="line.147"></a>
<span class="sourceLineNo">148</span>        try {<a name="line.148"></a>
<span class="sourceLineNo">149</span>            isUnderlyingConnectionClosed = getDelegateInternal().isClosed();<a name="line.149"></a>
<span class="sourceLineNo">150</span>        } catch (final SQLException e) {<a name="line.150"></a>
<span class="sourceLineNo">151</span>            try {<a name="line.151"></a>
<span class="sourceLineNo">152</span>                pool.invalidateObject(this);<a name="line.152"></a>
<span class="sourceLineNo">153</span>            } catch (final IllegalStateException ise) {<a name="line.153"></a>
<span class="sourceLineNo">154</span>                // pool is closed, so close the connection<a name="line.154"></a>
<span class="sourceLineNo">155</span>                passivate();<a name="line.155"></a>
<span class="sourceLineNo">156</span>                getInnermostDelegate().close();<a name="line.156"></a>
<span class="sourceLineNo">157</span>            } catch (final Exception ie) {<a name="line.157"></a>
<span class="sourceLineNo">158</span>                // DO NOTHING the original exception will be rethrown<a name="line.158"></a>
<span class="sourceLineNo">159</span>            }<a name="line.159"></a>
<span class="sourceLineNo">160</span>            throw new SQLException("Cannot close connection (isClosed check failed)", e);<a name="line.160"></a>
<span class="sourceLineNo">161</span>        }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span>        /*<a name="line.163"></a>
<span class="sourceLineNo">164</span>         * Can't set close before this code block since the connection needs to be open when validation runs. Can't set<a name="line.164"></a>
<span class="sourceLineNo">165</span>         * close after this code block since by then the connection will have been returned to the pool and may have<a name="line.165"></a>
<span class="sourceLineNo">166</span>         * been borrowed by another thread. Therefore, the close flag is set in passivate().<a name="line.166"></a>
<span class="sourceLineNo">167</span>         */<a name="line.167"></a>
<span class="sourceLineNo">168</span>        if (isUnderlyingConnectionClosed) {<a name="line.168"></a>
<span class="sourceLineNo">169</span>            // Abnormal close: underlying connection closed unexpectedly, so we<a name="line.169"></a>
<span class="sourceLineNo">170</span>            // must destroy this proxy<a name="line.170"></a>
<span class="sourceLineNo">171</span>            try {<a name="line.171"></a>
<span class="sourceLineNo">172</span>                pool.invalidateObject(this);<a name="line.172"></a>
<span class="sourceLineNo">173</span>            } catch (final IllegalStateException e) {<a name="line.173"></a>
<span class="sourceLineNo">174</span>                // pool is closed, so close the connection<a name="line.174"></a>
<span class="sourceLineNo">175</span>                passivate();<a name="line.175"></a>
<span class="sourceLineNo">176</span>                getInnermostDelegate().close();<a name="line.176"></a>
<span class="sourceLineNo">177</span>            } catch (final Exception e) {<a name="line.177"></a>
<span class="sourceLineNo">178</span>                throw new SQLException("Cannot close connection (invalidating pooled object failed)", e);<a name="line.178"></a>
<span class="sourceLineNo">179</span>            }<a name="line.179"></a>
<span class="sourceLineNo">180</span>        } else {<a name="line.180"></a>
<span class="sourceLineNo">181</span>            // Normal close: underlying connection is still open, so we<a name="line.181"></a>
<span class="sourceLineNo">182</span>            // simply need to return this proxy to the pool<a name="line.182"></a>
<span class="sourceLineNo">183</span>            try {<a name="line.183"></a>
<span class="sourceLineNo">184</span>                pool.returnObject(this);<a name="line.184"></a>
<span class="sourceLineNo">185</span>            } catch (final IllegalStateException e) {<a name="line.185"></a>
<span class="sourceLineNo">186</span>                // pool is closed, so close the connection<a name="line.186"></a>
<span class="sourceLineNo">187</span>                passivate();<a name="line.187"></a>
<span class="sourceLineNo">188</span>                getInnermostDelegate().close();<a name="line.188"></a>
<span class="sourceLineNo">189</span>            } catch (final SQLException | RuntimeException e) {<a name="line.189"></a>
<span class="sourceLineNo">190</span>                throw e;<a name="line.190"></a>
<span class="sourceLineNo">191</span>            } catch (final Exception e) {<a name="line.191"></a>
<span class="sourceLineNo">192</span>                throw new SQLException("Cannot close connection (return to pool failed)", e);<a name="line.192"></a>
<span class="sourceLineNo">193</span>            }<a name="line.193"></a>
<span class="sourceLineNo">194</span>        }<a name="line.194"></a>
<span class="sourceLineNo">195</span>    }<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>
<span class="sourceLineNo">197</span>    /**<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * @return The disconnection SQL codes.<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * @since 2.6.0<a name="line.199"></a>
<span class="sourceLineNo">200</span>     */<a name="line.200"></a>
<span class="sourceLineNo">201</span>    public Collection&lt;String&gt; getDisconnectionSqlCodes() {<a name="line.201"></a>
<span class="sourceLineNo">202</span>        return disconnectionSqlCodes;<a name="line.202"></a>
<span class="sourceLineNo">203</span>    }<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span>    /**<a name="line.205"></a>
<span class="sourceLineNo">206</span>     * Expose the {@link #toString()} method via a bean getter so it can be read as a property via JMX.<a name="line.206"></a>
<span class="sourceLineNo">207</span>     */<a name="line.207"></a>
<span class="sourceLineNo">208</span>    @Override<a name="line.208"></a>
<span class="sourceLineNo">209</span>    public String getToString() {<a name="line.209"></a>
<span class="sourceLineNo">210</span>        return toString();<a name="line.210"></a>
<span class="sourceLineNo">211</span>    }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span>    @Override<a name="line.213"></a>
<span class="sourceLineNo">214</span>    protected void handleException(final SQLException e) throws SQLException {<a name="line.214"></a>
<span class="sourceLineNo">215</span>        fatalSqlExceptionThrown |= isDisconnectionSqlException(e);<a name="line.215"></a>
<span class="sourceLineNo">216</span>        super.handleException(e);<a name="line.216"></a>
<span class="sourceLineNo">217</span>    }<a name="line.217"></a>
<span class="sourceLineNo">218</span><a name="line.218"></a>
<span class="sourceLineNo">219</span>    /**<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * {@inheritDoc}<a name="line.220"></a>
<span class="sourceLineNo">221</span>     * &lt;p&gt;<a name="line.221"></a>
<span class="sourceLineNo">222</span>     * This method should not be used by a client to determine whether or not a connection should be return to the<a name="line.222"></a>
<span class="sourceLineNo">223</span>     * connection pool (by calling {@link #close()}). Clients should always attempt to return a connection to the pool<a name="line.223"></a>
<span class="sourceLineNo">224</span>     * once it is no longer required.<a name="line.224"></a>
<span class="sourceLineNo">225</span>     */<a name="line.225"></a>
<span class="sourceLineNo">226</span>    @Override<a name="line.226"></a>
<span class="sourceLineNo">227</span>    public boolean isClosed() throws SQLException {<a name="line.227"></a>
<span class="sourceLineNo">228</span>        if (isClosedInternal()) {<a name="line.228"></a>
<span class="sourceLineNo">229</span>            return true;<a name="line.229"></a>
<span class="sourceLineNo">230</span>        }<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span>        if (getDelegateInternal().isClosed()) {<a name="line.232"></a>
<span class="sourceLineNo">233</span>            // Something has gone wrong. The underlying connection has been<a name="line.233"></a>
<span class="sourceLineNo">234</span>            // closed without the connection being returned to the pool. Return<a name="line.234"></a>
<span class="sourceLineNo">235</span>            // it now.<a name="line.235"></a>
<span class="sourceLineNo">236</span>            close();<a name="line.236"></a>
<span class="sourceLineNo">237</span>            return true;<a name="line.237"></a>
<span class="sourceLineNo">238</span>        }<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span>        return false;<a name="line.240"></a>
<span class="sourceLineNo">241</span>    }<a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span>    /**<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * Checks the SQLState of the input exception and any nested SQLExceptions it wraps.<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * &lt;p&gt;<a name="line.245"></a>
<span class="sourceLineNo">246</span>     * If {@link #disconnectionSqlCodes} has been set, sql states are compared to those in the<a name="line.246"></a>
<span class="sourceLineNo">247</span>     * configured list of fatal exception codes. If this property is not set, codes are compared against the default<a name="line.247"></a>
<span class="sourceLineNo">248</span>     * codes in {@link Utils#DISCONNECTION_SQL_CODES} and in this case anything starting with #{link<a name="line.248"></a>
<span class="sourceLineNo">249</span>     * Utils.DISCONNECTION_SQL_CODE_PREFIX} is considered a disconnection.<a name="line.249"></a>
<span class="sourceLineNo">250</span>     * &lt;/p&gt;<a name="line.250"></a>
<span class="sourceLineNo">251</span>     *<a name="line.251"></a>
<span class="sourceLineNo">252</span>     * @param e<a name="line.252"></a>
<span class="sourceLineNo">253</span>     *            SQLException to be examined<a name="line.253"></a>
<span class="sourceLineNo">254</span>     * @return true if the exception signals a disconnection<a name="line.254"></a>
<span class="sourceLineNo">255</span>     */<a name="line.255"></a>
<span class="sourceLineNo">256</span>    private boolean isDisconnectionSqlException(final SQLException e) {<a name="line.256"></a>
<span class="sourceLineNo">257</span>        boolean fatalException = false;<a name="line.257"></a>
<span class="sourceLineNo">258</span>        final String sqlState = e.getSQLState();<a name="line.258"></a>
<span class="sourceLineNo">259</span>        if (sqlState != null) {<a name="line.259"></a>
<span class="sourceLineNo">260</span>            fatalException = disconnectionSqlCodes == null<a name="line.260"></a>
<span class="sourceLineNo">261</span>                    ? sqlState.startsWith(Utils.DISCONNECTION_SQL_CODE_PREFIX)<a name="line.261"></a>
<span class="sourceLineNo">262</span>                            || Utils.DISCONNECTION_SQL_CODES.contains(sqlState)<a name="line.262"></a>
<span class="sourceLineNo">263</span>                    : disconnectionSqlCodes.contains(sqlState);<a name="line.263"></a>
<span class="sourceLineNo">264</span>            if (!fatalException) {<a name="line.264"></a>
<span class="sourceLineNo">265</span>                final SQLException nextException = e.getNextException();<a name="line.265"></a>
<span class="sourceLineNo">266</span>                if (nextException != null &amp;&amp; nextException != e) {<a name="line.266"></a>
<span class="sourceLineNo">267</span>                    fatalException = isDisconnectionSqlException(e.getNextException());<a name="line.267"></a>
<span class="sourceLineNo">268</span>                }<a name="line.268"></a>
<span class="sourceLineNo">269</span>            }<a name="line.269"></a>
<span class="sourceLineNo">270</span>        }<a name="line.270"></a>
<span class="sourceLineNo">271</span>        return fatalException;<a name="line.271"></a>
<span class="sourceLineNo">272</span>    }<a name="line.272"></a>
<span class="sourceLineNo">273</span><a name="line.273"></a>
<span class="sourceLineNo">274</span>    /**<a name="line.274"></a>
<span class="sourceLineNo">275</span>     * @return Whether to fail-fast.<a name="line.275"></a>
<span class="sourceLineNo">276</span>     * @since 2.6.0<a name="line.276"></a>
<span class="sourceLineNo">277</span>     */<a name="line.277"></a>
<span class="sourceLineNo">278</span>    public boolean isFastFailValidation() {<a name="line.278"></a>
<span class="sourceLineNo">279</span>        return fastFailValidation;<a name="line.279"></a>
<span class="sourceLineNo">280</span>    }<a name="line.280"></a>
<span class="sourceLineNo">281</span><a name="line.281"></a>
<span class="sourceLineNo">282</span>    @Override<a name="line.282"></a>
<span class="sourceLineNo">283</span>    protected void passivate() throws SQLException {<a name="line.283"></a>
<span class="sourceLineNo">284</span>        super.passivate();<a name="line.284"></a>
<span class="sourceLineNo">285</span>        setClosedInternal(true);<a name="line.285"></a>
<span class="sourceLineNo">286</span>        if (getDelegateInternal() instanceof PoolingConnection) {<a name="line.286"></a>
<span class="sourceLineNo">287</span>            ((PoolingConnection) getDelegateInternal()).connectionReturnedToPool();<a name="line.287"></a>
<span class="sourceLineNo">288</span>        }<a name="line.288"></a>
<span class="sourceLineNo">289</span>    }<a name="line.289"></a>
<span class="sourceLineNo">290</span><a name="line.290"></a>
<span class="sourceLineNo">291</span>    /**<a name="line.291"></a>
<span class="sourceLineNo">292</span>     * Actually close my underlying {@link Connection}.<a name="line.292"></a>
<span class="sourceLineNo">293</span>     */<a name="line.293"></a>
<span class="sourceLineNo">294</span>    @Override<a name="line.294"></a>
<span class="sourceLineNo">295</span>    public void reallyClose() throws SQLException {<a name="line.295"></a>
<span class="sourceLineNo">296</span>        if (jmxObjectName != null) {<a name="line.296"></a>
<span class="sourceLineNo">297</span>            jmxObjectName.unregisterMBean();<a name="line.297"></a>
<span class="sourceLineNo">298</span>        }<a name="line.298"></a>
<span class="sourceLineNo">299</span><a name="line.299"></a>
<span class="sourceLineNo">300</span>        if (validationPreparedStatement != null) {<a name="line.300"></a>
<span class="sourceLineNo">301</span>            Utils.closeQuietly(validationPreparedStatement);<a name="line.301"></a>
<span class="sourceLineNo">302</span>        }<a name="line.302"></a>
<span class="sourceLineNo">303</span><a name="line.303"></a>
<span class="sourceLineNo">304</span>        super.closeInternal();<a name="line.304"></a>
<span class="sourceLineNo">305</span>    }<a name="line.305"></a>
<span class="sourceLineNo">306</span><a name="line.306"></a>
<span class="sourceLineNo">307</span>    /**<a name="line.307"></a>
<span class="sourceLineNo">308</span>     * Validates the connection, using the following algorithm:<a name="line.308"></a>
<span class="sourceLineNo">309</span>     * &lt;ol&gt;<a name="line.309"></a>
<span class="sourceLineNo">310</span>     * &lt;li&gt;If {@code fastFailValidation} (constructor argument) is {@code true} and this connection has previously<a name="line.310"></a>
<span class="sourceLineNo">311</span>     * thrown a fatal disconnection exception, a {@code SQLException} is thrown.&lt;/li&gt;<a name="line.311"></a>
<span class="sourceLineNo">312</span>     * &lt;li&gt;If {@code sql} is null, the driver's #{@link Connection#isValid(int) isValid(timeout)} is called. If it<a name="line.312"></a>
<span class="sourceLineNo">313</span>     * returns {@code false}, {@code SQLException} is thrown; otherwise, this method returns successfully.&lt;/li&gt;<a name="line.313"></a>
<span class="sourceLineNo">314</span>     * &lt;li&gt;If {@code sql} is not null, it is executed as a query and if the resulting {@code ResultSet} contains at<a name="line.314"></a>
<span class="sourceLineNo">315</span>     * least one row, this method returns successfully. If not, {@code SQLException} is thrown.&lt;/li&gt;<a name="line.315"></a>
<span class="sourceLineNo">316</span>     * &lt;/ol&gt;<a name="line.316"></a>
<span class="sourceLineNo">317</span>     *<a name="line.317"></a>
<span class="sourceLineNo">318</span>     * @param sql<a name="line.318"></a>
<span class="sourceLineNo">319</span>     *            The validation SQL query.<a name="line.319"></a>
<span class="sourceLineNo">320</span>     * @param timeoutSeconds<a name="line.320"></a>
<span class="sourceLineNo">321</span>     *            The validation timeout in seconds.<a name="line.321"></a>
<span class="sourceLineNo">322</span>     * @throws SQLException<a name="line.322"></a>
<span class="sourceLineNo">323</span>     *             Thrown when validation fails or an SQLException occurs during validation<a name="line.323"></a>
<span class="sourceLineNo">324</span>     */<a name="line.324"></a>
<span class="sourceLineNo">325</span>    public void validate(final String sql, int timeoutSeconds) throws SQLException {<a name="line.325"></a>
<span class="sourceLineNo">326</span>        if (fastFailValidation &amp;&amp; fatalSqlExceptionThrown) {<a name="line.326"></a>
<span class="sourceLineNo">327</span>            throw new SQLException(Utils.getMessage("poolableConnection.validate.fastFail"));<a name="line.327"></a>
<span class="sourceLineNo">328</span>        }<a name="line.328"></a>
<span class="sourceLineNo">329</span><a name="line.329"></a>
<span class="sourceLineNo">330</span>        if (sql == null || sql.isEmpty()) {<a name="line.330"></a>
<span class="sourceLineNo">331</span>            if (timeoutSeconds &lt; 0) {<a name="line.331"></a>
<span class="sourceLineNo">332</span>                timeoutSeconds = 0;<a name="line.332"></a>
<span class="sourceLineNo">333</span>            }<a name="line.333"></a>
<span class="sourceLineNo">334</span>            if (!isValid(timeoutSeconds)) {<a name="line.334"></a>
<span class="sourceLineNo">335</span>                throw new SQLException("isValid() returned false");<a name="line.335"></a>
<span class="sourceLineNo">336</span>            }<a name="line.336"></a>
<span class="sourceLineNo">337</span>            return;<a name="line.337"></a>
<span class="sourceLineNo">338</span>        }<a name="line.338"></a>
<span class="sourceLineNo">339</span><a name="line.339"></a>
<span class="sourceLineNo">340</span>        if (!sql.equals(lastValidationSql)) {<a name="line.340"></a>
<span class="sourceLineNo">341</span>            lastValidationSql = sql;<a name="line.341"></a>
<span class="sourceLineNo">342</span>            // Has to be the innermost delegate else the prepared statement will<a name="line.342"></a>
<span class="sourceLineNo">343</span>            // be closed when the pooled connection is passivated.<a name="line.343"></a>
<span class="sourceLineNo">344</span>            validationPreparedStatement = getInnermostDelegateInternal().prepareStatement(sql);<a name="line.344"></a>
<span class="sourceLineNo">345</span>        }<a name="line.345"></a>
<span class="sourceLineNo">346</span><a name="line.346"></a>
<span class="sourceLineNo">347</span>        if (timeoutSeconds &gt; 0) {<a name="line.347"></a>
<span class="sourceLineNo">348</span>            validationPreparedStatement.setQueryTimeout(timeoutSeconds);<a name="line.348"></a>
<span class="sourceLineNo">349</span>        }<a name="line.349"></a>
<span class="sourceLineNo">350</span><a name="line.350"></a>
<span class="sourceLineNo">351</span>        try (ResultSet rs = validationPreparedStatement.executeQuery()) {<a name="line.351"></a>
<span class="sourceLineNo">352</span>            if (!rs.next()) {<a name="line.352"></a>
<span class="sourceLineNo">353</span>                throw new SQLException("validationQuery didn't return a row");<a name="line.353"></a>
<span class="sourceLineNo">354</span>            }<a name="line.354"></a>
<span class="sourceLineNo">355</span>        } catch (final SQLException sqle) {<a name="line.355"></a>
<span class="sourceLineNo">356</span>            throw sqle;<a name="line.356"></a>
<span class="sourceLineNo">357</span>        }<a name="line.357"></a>
<span class="sourceLineNo">358</span>    }<a name="line.358"></a>
<span class="sourceLineNo">359</span>}<a name="line.359"></a>




























































</pre>
</div>
</body>
</html>
